home *** CD-ROM | disk | FTP | other *** search
/ Network Support Library / RoseWare - Network Support Library.iso / apidev / tpapi.exe / DOCS / OLDDOCS.LZH / NWMESS.DOC < prev    next >
Text File  |  1992-10-26  |  7KB  |  166 lines
  1.                                MESSAGE SERVICES
  2.                                ================
  3.  
  4. --------------------------------------------------------------------------------
  5.  
  6.   BroadcastToConsole (Message : ConsoleMessageType) : WORD;
  7.  
  8.     Broadcasts a message to the default file server's system console.
  9.  
  10.     Message (Input)                   : string containing message to send.
  11.  
  12. --------------------------------------------------------------------------------
  13.  
  14.   CheckPipeStatus (ConnectionList : ConnectionListType;
  15.                    VAR ResultList : ConnectionListType;
  16.                    VAR ConnectionCount : BYTE) : WORD;
  17.  
  18.     Allows a client to monitor the status of one or more of its message pipes.
  19.     NOTE : Netware 286 only.
  20.  
  21.     ConnectionList (Input)            : list of connections with which to check.
  22.  
  23.     ResultList (Output)               : list of status codes for each connection
  24.                                         in ConnectionList.
  25.  
  26.     ConnectionCount (Output)          : Number of message pipes that the
  27.                                         requesting workstation wants to monitor.
  28.  
  29. --------------------------------------------------------------------------------
  30.  
  31.   CloseMessagePipe (ConnectionList : ConnectionListType;
  32.                     VAR ResultList : ConnectionListType;
  33.                     VAR ConnectionCount : BYTE) : WORD;
  34.  
  35.     Closes the requesting workstation's half of one or more message pipes
  36.     offered to one or more logical connections on the default file server.
  37.     NOTE : Netware 286 only.
  38.  
  39.     ConnectionList (Input)            : list of connections with which to close
  40.                                         a pipe.
  41.  
  42.     ResultList (Output)               : list of status codes for each connection
  43.                                         in ConnectionList.
  44.  
  45.     ConnectionCount (Output)          : Number of message pipes that the
  46.                                         requesting workstation wants to close.
  47.  
  48. --------------------------------------------------------------------------------
  49.  
  50.   DisableBroadcasts : WORD;
  51.  
  52.     Disables message reception.
  53.  
  54. --------------------------------------------------------------------------------
  55.  
  56.   EnableBroadcasts : WORD;
  57.  
  58.     Enables message reception.
  59.  
  60. --------------------------------------------------------------------------------
  61.  
  62.   GetBroadcastMessage (VAR Message : BroadcastMessageType) : WORD;
  63.  
  64.     Enables an application to poll for and return a broadcast message from the
  65.     default file server.
  66.  
  67.     Message (Output)                  : string containing the message.
  68.  
  69. --------------------------------------------------------------------------------
  70.  
  71.   GetBroadcastMode : WORD;
  72.  
  73.     Returns the message mode of the requesting workstation.
  74.  
  75. --------------------------------------------------------------------------------
  76.  
  77.   GetPersonalMessage (VAR Message : PersonalMessageType;
  78.                       VAR SourceConnection : WORD) : WORD;
  79.  
  80.     Enables an application to poll for and return the next message in the
  81.     requesting workstation's pipe queue on the default server.
  82.     NOTE : Netware 286 only.
  83.  
  84.     Message (Output)                  : string containing the oldest message.
  85.  
  86.     SourceConnection (Output)         : connection number of the sending
  87.                                         station.
  88.  
  89. --------------------------------------------------------------------------------
  90.  
  91.   LogNetworkMessage (Message : ConsoleMessageType) : WORD;
  92.  
  93.     Logs a message to the default file server's NET$LOG.MSG file.
  94.  
  95.     Message (Input)                   : message to be logged.
  96.  
  97. --------------------------------------------------------------------------------
  98.  
  99.   OpenMessagePipe (ConnectionList : ConnectionListType;
  100.                    VAR ResultList : ConnectionListType;
  101.                    VAR ConnectionCount : BYTE) : WORD;
  102.  
  103.     Creates the requesting workstation's half of one or more message pipes
  104.     offered to one or more logical connections on the default file server.
  105.     NOTE : Netware 286 only.
  106.  
  107.     ConnectionList (Input)            : list of connections with which to open
  108.                                         a pipe.
  109.  
  110.     ResultList (Output)               : list of status codes for each connection
  111.                                         in ConnectionList.
  112.  
  113.     ConnectionCount (Output)          : Number of message pipes that the
  114.                                         requesting workstation wants to open.
  115.  
  116. --------------------------------------------------------------------------------
  117.  
  118.   SendBroadcastMessage (Message : BroadcastMessageType;
  119.                         ConnectionList : ConnectionListType;
  120.                         VAR ResultList : ConnectionListType;
  121.                         ConnectionCount : BYTE) : WORD;
  122.  
  123.     Sends a broadcast message to the specified logical connection(s) on the
  124.     default file server.
  125.  
  126.     Message (Input)                   : message to be sent.
  127.  
  128.     ConnectionList (Input)            : list of connection numbers who will
  129.                                         receive the message.
  130.  
  131.     ResultList (Output)               : list of status codes for each connection
  132.                                         in ConnectionList.
  133.  
  134.     ConnectionCount (Output)          : Number of message pipes that the
  135.                                         requesting workstation wants to send to.
  136.  
  137. --------------------------------------------------------------------------------
  138.  
  139.   SendPersonalMessage (Message : PersonalMessageType;
  140.                        ConnectionList : ConnectionListType;
  141.                        VAR ResultList : ConnectionListType;
  142.                        ConnectionCount : BYTE) : WORD;
  143.  
  144.     Sends a pipe message to the specified logical connection(s) on the default
  145.     file server.
  146.     NOTE : Netware 286 only.
  147.  
  148.     Message (Input)                   : message to be sent.
  149.  
  150.     ConnectionList (Input)            : list of connection numbers who will
  151.                                         receive the message.
  152.  
  153.     ResultList (Output)               : list of status codes for each connection
  154.                                         in ConnectionList.
  155.  
  156.     ConnectionCount (Output)          : Number of message pipes that the
  157.                                         requesting workstation wants to send to.
  158.  
  159. --------------------------------------------------------------------------------
  160.  
  161.   SetBroadcastMode (BroadcaseMode : WORD);
  162.  
  163.     Sets the message mode of the requesting workstation.
  164.  
  165. ------------------------------------------------------------------------------
  166.